AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

A strongly-typed object for retrieving search results (Query or Scan) from DynamoDB.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DataModel.AsyncSearch<>

Namespace: Amazon.DynamoDBv2.DataModel
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

C# 
public class AsyncSearch<>

The AsyncSearch<> type exposes the following members

Properties

NameTypeDescription
Public Property IsDone System.Boolean

Flag that, if true, indicates that the search is done

Public Property PaginationToken System.String

Pagination token corresponding to the item where the search operation stopped, inclusive of the previous result set. Use this value to start a new operation to resume search from the next item.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method GetNextSetAsync(CancellationToken)

Initiates the asynchronous execution to get the next set of results from DynamoDB. If there are more items in the Scan/Query, PaginationToken will be set and can be consumed in a new Scan/Query operation to resume retrieving items from this point.

Public Method GetRemainingAsync(CancellationToken)

Initiates the asynchronous execution to get all the remaining results from DynamoDB.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5